/*
 * Copyright 2010 Biz-e (info@biz-e.nl)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.gwt.baselib.validation.client;

/**
 * TODO: Write type comment
 * 
 * @author Joost A. Bloemsma
 */
public interface Validator {
	/**
	 * Validates the passed value
	 * 
	 * @param value
	 * @return true if correct
	 */
	public boolean validate(Object value);
	
	/**
	 * returns the errormessage (if any) generated
	 * by the validation
	 * 
	 * @return String
	 */
	public String getErrorMessage();
	
	/**
	 * returns a message explaining the constraints of the validation
	 * 
	 * @return String
	 */
	public String getHelpMessage();
	
	/**
	 * Sets the errormessage to be generated in case of a validation error
	 * 
	 * @param msg
	 */
	public void setErrorMessage(String msg);
	
	/**
	 * Sets the helpmessage for this validation
	 * 
	 * @param msg
	 */
	public void setHelpMessage(String msg);
}
